/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014 abel533@gmail.com
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.eppear.jpfm.framework.service;

import org.springframework.stereotype.Service;

import com.eppear.jpfm.framework.common.DtPage;
import com.eppear.jpfm.framework.util.datatables.DtParm;

import java.util.List;
import java.util.Map;

/**
 * 通用接口
 */
@Service
public interface IService<T> {

	/**
	 * @Title select 
	 * @Description 
	 *   查询全部结果
	 * @author JianFeng Zhang(张建锋) 
	 * @data   2017-04-15 上午9:34:26
	 * @return
	 */
	List<T> select();
	
	/**
	 * @Title select 
	 * @Description 
	 *   通用查询,根据实体中的属性值进行查询，查询条件使用等号
	 * @author JianFeng Zhang(张建锋) 
	 * @data   2017-04-13 上午11:52:35
	 * @param  record
	 * @return
	 */
	List<T> select(T record);
	
	/**
	 * @Title selectAllDtPage 
	 * @Description 
	 *   分页-通用查询,查询全部结果
	 * @author JianFeng Zhang(张建锋) 
	 * @data   2017-04-15 上午9:34:41
	 * @return
	 */
	DtPage selectDtPage(DtParm pageParm);
	/**
	 * @Title selectDtPage 
	 * @Description 
	 *   分页-通用查询,根据实体中的属性值进行查询，查询条件使用等号
	 *   
	 * @author JianFeng Zhang(张建锋) 
	 * @data   2017-04-13 下午1:53:33
	 * @param record
	 * @return
	 */
	DtPage selectDtPage(T record,DtParm pageParm);
	
    /**
     * @Description 通用查询方法,按主键进行单表查询
     * @param key 主键值
     * @return 数据库记录对应的实体实例
     */
    T selectByKey(Object key);

    /**
     * @Title selectByExample 
     * @Description 
     *   根据Example条件进行查询
     * @author JianFeng Zhang(张建锋) 
     * @data   2017-04-13 上午11:47:36
     * @param example
     * @return
     */
    List<T> selectByExample(Object example);
    /**
     * @Title save 
     * @Description 
     *   保存一个实体，null的属性也会保存，不会使用数据库默认值
     * @author JianFeng Zhang(张建锋) 
     * @data   2017-04-13 上午11:42:02
     * @param entity
     * @return
     */
    int save(T entity);
    
    /**
     * @Title saveNotNull 
     * @Description 
     *   保存一个实体,null的属性不保存，使用数据库默认值
     * @author JianFeng Zhang(张建锋) 
     * @data   2017-04-13 上午11:42:44
     * @param entity
     * @return
     */
    int saveNotNull(T entity);

    int delete(Object key);

    /**
     * @Title update 
     * @Description 
     *   根据主键更新实体全部字段，null值会被更新
     * @author JianFeng Zhang(张建锋) 
     * @data   2017-04-13 下午2:08:50
     * @param entity
     * @return
     */
    int update(T entity);

    /**
     * @Title updateNotNull 
     * @Description 
     *   根据主键更新属性不为null的值
     * @author JianFeng Zhang(张建锋) 
     * @data   2017-04-13 下午2:09:44
     * @param entity
     * @return
     */
    int updateNotNull(T entity);


    //TODO 其他通用性接口
    
   
    /**
	 * @Description
	 *   查询单条记录的方法
	 * @author JianFeng Zhang(张建锋)
	 * @date 2017-01-16 下午7:58:24
	 * @param sqlId SQL语句ID,即文件中的namespace.SQLID
	 * @param parameter  查询参数
	 * @return Map类型的记录,如果有多条,则会报错
	 */
	public Map<String,Object> selectOneFromXML(String sqlId, Object parameter);
	/**
	 * @Description
	 * 	查询单条记录的方法,用于无需SQL参数的情况
	 * @author JianFeng Zhang(张建锋)
	 * @date 2017-01-16 下午8:31:46
	 * @param sqlId SQL语句ID,即文件中的namespace.SQLID
	 * @return
	 */
	public Map<String,Object> selectOneFromXML(String sqlId);
	
	/**
	 * @Description
	 *         查询多条记录的方法
	 * @author JianFeng Zhang(张建锋)
	 * @date 2017-01-16 下午8:23:33
	 * @param sqlId SQL语句ID,即文件中的namespace.SQLID
	 * @param parameter 查询参数
	 * @return 类型为 List<Map>
	 */
	public List<Map> selectFromXML(String sqlId, Object parameter);
	
	/**
	 * @Description
	 * 查询多条记录的方法 ,用于无需SQL参数的情况
	 * @author JianFeng Zhang(张建锋)
	 * @date 2017-01-16 下午8:38:07
	 * @param sqlId SQL语句ID,即文件中的namespace.SQLID
	 * @return 类型为 List<Map>
	 */
	public List<Map> selectFromXML(String sqlId);	
	
	/**
	 *   分页-通用查询,查询多条记录的方法
	 * @author JianFeng Zhang(张建锋) 
	 * @data   2017-04-16 下午5:41:41
	 * @param sqlId SQL语句ID,即文件中的namespace.SQLID
	 * @param parameter 查询参数
	 * @param pageParm  分页参数
	 * @return Page对象
	 */
	public DtPage selectFromXMLDtPage(String sqlId, Object parameter,DtParm pageParm);
	
	/**
	 *   分页-通用查询,查询多条记录的方法,用于无需SQL参数的情况
	 * @author JianFeng Zhang(张建锋) 
	 * @data   2017-04-16 下午5:41:41
	 * @param sqlId SQL语句ID,即文件中的namespace.SQLID
	 * @param pageParm  分页参数
	 * @return Page对象
	 */
	public DtPage selectFromXMLDtPage(String sqlId,DtParm pageParm);
}
